gridpack::optimization::OptimizerInterface Class Reference

#include <optimizer.hpp>

Inheritance diagram for gridpack::optimization::OptimizerInterface:

[legend]

List of all members.

Public Member Functions
	OptimizerInterface (void)
	Default constructor.
virtual	~OptimizerInterface (void)
	Destructor.
virtual void	setFilename (std::string file)
	Set filename for output.
void	addVariable (VariablePtr v)
	Add a (local) variable to be optimized.
void	addAuxVariable (VariablePtr v)
void	addConstraint (ConstraintPtr c)
	Add a (local) constraint.
void	createGlobalConstraint (const std::string &name, ConstraintPtr cons)
	Create a global constraint (with possibly empty LHS).
void	addToGlobalConstraint (const std::string &name, ExpressionPtr expr)
	Add to the LHS of a global constraint, maybe.
void	addToObjective (ExpressionPtr expr)
	Add to the local part of the global objective function, maybe.
void	maximize (void)
	Maximize the objective.
void	minimize (void)
	Minimize the objective.

---

Constructor & Destructor Documentation

gridpack::optimization::OptimizerInterface::OptimizerInterface

(

void

)

Default constructor.

virtual gridpack::optimization::OptimizerInterface::~OptimizerInterface

(

void

)

[virtual]

Destructor.

---

Member Function Documentation

void gridpack::optimization::OptimizerInterface::addAuxVariable

(

VariablePtr

v

)

Add a (local) auxiliary variable. This is used for parallel applications to create ghost copies of variables defined on other processors

void gridpack::optimization::OptimizerInterface::addConstraint

(

ConstraintPtr

c

)

Add a (local) constraint.

void gridpack::optimization::OptimizerInterface::addToGlobalConstraint	(	const std::string &	name,
		ExpressionPtr	expr
	)

Add to the LHS of a global constraint, maybe.

void gridpack::optimization::OptimizerInterface::addToObjective

(

ExpressionPtr

expr

)

Add to the local part of the global objective function, maybe.

void gridpack::optimization::OptimizerInterface::addVariable

(

VariablePtr

v

)

Add a (local) variable to be optimized.

void gridpack::optimization::OptimizerInterface::createGlobalConstraint	(	const std::string &	name,
		ConstraintPtr	cons
	)

Create a global constraint (with possibly empty LHS).

It's assumed that all processes that contribute to a global constraint will call this routine with an equivalent Constraint instance, i.e., the operator and RHS will be the same on all proceses.

Parameters:

	name
	cons

void gridpack::optimization::OptimizerInterface::maximize

(

void

)

Maximize the objective.

void gridpack::optimization::OptimizerInterface::minimize

(

void

)

Minimize the objective.

virtual void gridpack::optimization::OptimizerInterface::setFilename

(

std::string

file

)

[virtual]

Set filename for output.

---

The documentation for this class was generated from the following file:

• optimizer.hpp